Summary

Fully Qualified Name:	Laminas\Captcha\AbstractWord
Extends:	AbstractAdapter

Description

Methods

Name	Description	Defined By
__construct()	Abstract constructor for all validators A validator should accept following parameters: - nothing f.e. Validator() - one or multiple scalar values f.e. Validator($first, $second, $third) - an array f.e. Validator(array($first => 'first', $second => 'second', $third => 'third')) - an instance of Traversable f.e. Validator($config_instance)	AbstractValidator
__get()	Magic function returns the value of the requested property, if and only if it is the value or a message variable.	AbstractValidator
__invoke()	Invoke as command	AbstractValidator
generate()	Generate new session ID and new word	AbstractWord
getDefaultTranslator()	Get default translation object for all validate objects	AbstractValidator
getDefaultTranslatorTextDomain()	Get default translation text domain for all validate objects	AbstractValidator
getHelperName()	Get helper name used to render captcha	AbstractWord
getId()	Retrieve captcha ID	AbstractWord
getMessageLength()	Returns the maximum allowed message length	AbstractValidator
getMessageTemplates()	Returns the message templates from the validator	AbstractValidator
getMessageVariables()	Returns an array of the names of variables that are used in constructing validation failure messages	AbstractValidator
getMessages()	Returns array of validation failure messages	AbstractValidator
getName()	Get name	AbstractAdapter
getOption()	Returns an option	AbstractValidator
getOptions()	Retrieve options representing object state	AbstractAdapter
getSession()	Get session object	AbstractWord
getSessionClass()	Retrieve session class to utilize	AbstractWord
getTimeout()	Get session token timeout	AbstractWord
getTranslator()	Return translation object	AbstractValidator
getTranslatorTextDomain()	Return the translation text domain	AbstractValidator
getUseNumbers()	Numbers should be included in the pattern?	AbstractWord
getWord()	Get captcha word	AbstractWord
getWordlen()	Retrieve word length to use when generating captcha	AbstractWord
hasDefaultTranslator()	Is there a default translation object set?	AbstractValidator
hasTranslator()	Does this validator have its own specific translator?	AbstractValidator
isTranslatorEnabled()	Is translation enabled?	AbstractValidator
isValid()	Validate the word	AbstractWord
isValueObscured()	Retrieve flag indicating whether or not value should be obfuscated in messages	AbstractValidator
setDefaultTranslator()	Set default translation object for all validate objects	AbstractValidator
setDefaultTranslatorTextDomain()	Set default translation text domain for all validate objects	AbstractValidator
setKeepSession()	Sets if session should be preserved on generate()	AbstractWord
setMessage()	Sets the validation failure message template for a particular key	AbstractValidator
setMessageLength()	Sets the maximum allowed message length	AbstractValidator
setMessages()	Sets validation failure message templates given as an array, where the array keys are the message keys, and the array values are the message template strings.	AbstractValidator
setName()	Set name	AbstractAdapter
setOption()	Set single option for the object	AbstractAdapter
setOptions()	Set object state from options array	AbstractAdapter
setSession()	Set session namespace object	AbstractWord
setSessionClass()	Set session class for persistence	AbstractWord
setTimeout()	Set timeout for session token	AbstractWord
setTranslator()	Set translation object	AbstractValidator
setTranslatorEnabled()	Indicate whether or not translation should be enabled	AbstractValidator
setTranslatorTextDomain()	Set translation text domain	AbstractValidator
setUseNumbers()	Set if numbers should be included in the pattern	AbstractWord
setValueObscured()	Set flag indicating whether or not value should be obfuscated in messages	AbstractValidator
setWordlen()	Set word length of captcha	AbstractWord

Method Details

__construct()

Abstract constructor for all validators A validator should accept following parameters: - nothing f.e. Validator() - one or multiple scalar values f.e. Validator($first, $second, $third) - an array f.e. Validator(array($first => 'first', $second => 'second', $third => 'third')) - an instance of Traversable f.e. Validator($config_instance)

Parameter Name	Type	Description
$options	array|\Traversable

Returns:

__get()

Magic function returns the value of the requested property, if and only if it is the value or a message variable.

Parameter Name	Type	Description
$property	string

Returns: mixed

__invoke()

Invoke as command

Parameter Name	Type	Description
$value	mixed

Returns: bool

generate()

Generate new session ID and new word

Returns: string session ID

getDefaultTranslator()

Get default translation object for all validate objects

Returns: \Translator\TranslatorInterface|null

getDefaultTranslatorTextDomain()

Get default translation text domain for all validate objects

Returns: string

getHelperName()

Get helper name used to render captcha

Returns: string

getId()

Retrieve captcha ID

Returns: string

getMessageLength()

Returns the maximum allowed message length

Returns: int

getMessageTemplates()

Returns the message templates from the validator

Returns: array

getMessageVariables()

Returns an array of the names of variables that are used in constructing validation failure messages

Returns: array

getMessages()

Returns array of validation failure messages

Returns: array

getName()

Get name

Returns: string

getOption()

Returns an option

Parameter Name	Type	Description
$option	string	Option

Returns: mixed Returned option

getOptions()

Retrieve options representing object state

Returns: array

getSession()

Get session object

Returns: \Container

getSessionClass()

Retrieve session class to utilize

Returns: string

getTimeout()

Get session token timeout

Returns: int

getTranslator()

Return translation object

Returns: \Translator\TranslatorInterface|null

getTranslatorTextDomain()

Return the translation text domain

Returns: string

getUseNumbers()

Numbers should be included in the pattern?

Returns: bool

getWord()

Get captcha word

Returns: string

getWordlen()

Retrieve word length to use when generating captcha

Returns: int

hasDefaultTranslator()

Is there a default translation object set?

Returns: bool

hasTranslator()

Does this validator have its own specific translator?

Returns: bool

isTranslatorEnabled()

Is translation enabled?

Returns: bool

isValid()

Validate the word

Parameter Name	Type	Description
$value	mixed
$context	mixed

Returns: bool

isValueObscured()

Retrieve flag indicating whether or not value should be obfuscated in messages

Returns: bool

setDefaultTranslator()

Set default translation object for all validate objects

Parameter Name	Type	Description
$translator	\Translator\TranslatorInterface|null
$textDomain	string	(optional)

Returns: void

setDefaultTranslatorTextDomain()

Set default translation text domain for all validate objects

Parameter Name	Type	Description
$textDomain	string

Returns: void

setKeepSession()

Sets if session should be preserved on generate()

Parameter Name	Type	Description
$keepSession	bool	Should

Returns: \AbstractWord Provides a fluent interface

setMessage()

Sets the validation failure message template for a particular key

Parameter Name	Type	Description
$messageString	string
$messageKey	string	OPTIONAL

Returns: $this Provides a fluent interface

setMessageLength()

Sets the maximum allowed message length

Parameter Name	Type	Description
$length	int

Returns:

setMessages()

Sets validation failure message templates given as an array, where the array keys are the message keys, and the array values are the message template strings.

Parameter Name	Type	Description
$messages	array

Returns: $this

setName()

Set name

Parameter Name	Type	Description
$name	string

Returns: \AbstractAdapter Provides a fluent interface

setOption()

Set single option for the object

Parameter Name	Type	Description
$key	string
$value	string

Returns: \AbstractAdapter Provides a fluent interface

setOptions()

Set object state from options array

Parameter Name	Type	Description
$options	array|\Traversable

Returns: \AbstractAdapter Provides a fluent interface

setSession()

Set session namespace object

Parameter Name	Type	Description
$session	\Container

Returns: \AbstractWord Provides a fluent interface

setSessionClass()

Set session class for persistence

Parameter Name	Type	Description
$sessionClass	string

Returns: \AbstractWord Provides a fluent interface

setTimeout()

Set timeout for session token

Parameter Name	Type	Description
$ttl	int

Returns: \AbstractWord Provides a fluent interface

setTranslator()

Set translation object

Parameter Name	Type	Description
$translator	\Translator\TranslatorInterface|null
$textDomain	string	(optional)

Returns: $this

setTranslatorEnabled()

Indicate whether or not translation should be enabled

Parameter Name	Type	Description
$flag	bool

Returns: $this

setTranslatorTextDomain()

Set translation text domain

Parameter Name	Type	Description
$textDomain	string

Returns: $this

setUseNumbers()

Set if numbers should be included in the pattern

Parameter Name	Type	Description
$useNumbers	bool	numbers

Returns: \AbstractWord Provides a fluent interface

setValueObscured()

Set flag indicating whether or not value should be obfuscated in messages

Parameter Name	Type	Description
$flag	bool

Returns: $this

setWordlen()

Set word length of captcha

Parameter Name	Type	Description
$wordlen	int

Returns: \AbstractWord Provides a fluent interface